        <!DOCTYPE html>
        <html>
        <head>
                <meta charset="utf-8">
        <title>Joint class / box2d_console Library / Dart Documentation</title>
        <link rel="stylesheet" type="text/css"
            href="../styles.css">
        <link href="http://fonts.googleapis.com/css?family=Open+Sans:400,600,700,800" rel="stylesheet" type="text/css">
        <link rel="shortcut icon" href="../favicon.ico">
        
        </head>
        <body data-library="box2d_console" data-type="Joint">
        <div class="page">
        <div class="header">
          <a href="../index.html"><div class="logo"></div></a>
          <a href="../index.html">Dart Documentation</a>
         &rsaquo; <a href="../box2d_console.html">box2d_console</a> &rsaquo; <a href="../box2d_console/Joint.html">Joint</a>        <div id="search-box">
          <input type="search" name="q" id="q" autocomplete="off"
              class="search-input" placeholder="Search API">
        </div>
        
      </div>
      <div class="drop-down" id="drop-down"></div>
      
        <div class="nav">
        
</div>
<div class="content">
        <h2><strong>Joint</strong>
          class
        </h2>
        
<button id="show-inherited" class="show-inherited">Hide inherited</button>
<div class="doc">
<p>The base joint class. Joints are used to constrain two bodies together in
various fashions. Some joints also feature limits and motors.</p>
<pre class="source">
class Joint {
  int type;

  Joint _prev;
  Joint _next;

  JointEdge edgeA;
  JointEdge edgeB;

  Body bodyA;
  Body bodyB;

  bool islandFlag;

  bool collideConnected;

  Object userData;

  // Cache here per time step to reduce cache misses.
  final Vector localCenterA;
  final Vector localCenterB;

  num invMassA;
  num invIA;
  num invMassB;
  num invIB;

  Joint(JointDef def) :
    type = def.type,
    _prev = null,
    _next = null,
    bodyA = def.bodyA,
    bodyB = def.bodyB,
    collideConnected = def.collideConnected,
    islandFlag = false,
    userData = def.userData,

    localCenterA = new Vector(),
    localCenterB = new Vector(),
    edgeA = new JointEdge(),
    edgeB = new JointEdge() { }

  // TODO(dominich): use 'is' to create the right type of Joint and remove the
  // *Def.type.
  factory Joint.create(World argWorld, JointDef def) {
    switch(def.type){
      case JointType.MOUSE:
        throw new NotImplementedException();
        //  return new MouseJoint(def);
      case JointType.DISTANCE:
        return new DistanceJoint(def);
      case JointType.PRISMATIC:
        throw new NotImplementedException();
        //  return new PrismaticJoint(def);
      case JointType.REVOLUTE:
        return new RevoluteJoint(def);
      case JointType.WELD:
        throw new NotImplementedException();
        //return new WeldJoint(def);
      case JointType.FRICTION:
        return new FrictionJoint(def);
      case JointType.LINE:
        throw new NotImplementedException();
        //return new LineJoint(def);
      case JointType.GEAR:
        throw new NotImplementedException();
        //return new GearJoint(def);
      case JointType.PULLEY:
        throw new NotImplementedException();
        //return new PulleyJoint(def);
      case JointType.CONSTANT_VOLUME:
        return new ConstantVolumeJoint(argWorld, def);
    }
    return null;
  }

  static void destroy(Joint joint) {
    joint.destructor();
  }

  /**
   * Get the anchor point on bodyA in world coordinates.
   */
  void getAnchorA(Vector argOut) { }

  /**
   * Get the anchor point on bodyB in world coordinates.
   */
  void getAnchorB(Vector argOut) { }

  /**
   * Get the reaction force on body2 at the joint anchor in Newtons.
   */
  void getReactionForce(num inv_dt, Vector argOut) { }

  /**
   * Get the reaction torque on body2 in N*m.
   */
  num getReactionTorque(num inv_dt) { }

  /**
   * Short-cut function to determine if either body is inactive.
   */
  bool get active() {
    return bodyA.active &amp;&amp; bodyB.active;
  }

  void initVelocityConstraints(TimeStep step) { }

  void solveVelocityConstraints(TimeStep step) { }

  /**
   * This returns true if the position errors are within tolerance.
   */
  bool solvePositionConstraints(num baumgarte) { }

  /**
   * Override to handle destruction of joint
   */
  void destructor() { }
}
</pre>
</div>
<h3>Subclasses</h3>
<p>
<span class="type-box"><span class="icon-class"></span><a href="../box2d_console/ConstantVolumeJoint.html">ConstantVolumeJoint</a></span>, <span class="type-box"><span class="icon-class"></span><a href="../box2d_console/DistanceJoint.html">DistanceJoint</a></span>, <span class="type-box"><span class="icon-class"></span><a href="../box2d_console/FrictionJoint.html">FrictionJoint</a></span>, <span class="type-box"><span class="icon-class"></span><a href="../box2d_console/RevoluteJoint.html">RevoluteJoint</a></span></p>
<div>
<h3>Constructors</h3>
<div class="method"><h4 id="Joint">
<button class="show-code">Code</button>
new <strong>Joint</strong>(<a href="../box2d_console/JointDef.html">JointDef</a> def) <a class="anchor-link" href="#Joint"
              title="Permalink to Joint.Joint">#</a></h4>
<div class="doc">
<pre class="source">
Joint(JointDef def) :
  type = def.type,
  _prev = null,
  _next = null,
  bodyA = def.bodyA,
  bodyB = def.bodyB,
  collideConnected = def.collideConnected,
  islandFlag = false,
  userData = def.userData,

  localCenterA = new Vector(),
  localCenterB = new Vector(),
  edgeA = new JointEdge(),
  edgeB = new JointEdge() { }
</pre>
</div>
</div>
<div class="method"><h4 id="Joint.create">
<button class="show-code">Code</button>
factory <strong>Joint.create</strong>(<a href="../box2d_console/World.html">World</a> argWorld, <a href="../box2d_console/JointDef.html">JointDef</a> def) <a class="anchor-link" href="#Joint.create"
              title="Permalink to Joint.Joint.create">#</a></h4>
<div class="doc">
<pre class="source">
factory Joint.create(World argWorld, JointDef def) {
  switch(def.type){
    case JointType.MOUSE:
      throw new NotImplementedException();
      //  return new MouseJoint(def);
    case JointType.DISTANCE:
      return new DistanceJoint(def);
    case JointType.PRISMATIC:
      throw new NotImplementedException();
      //  return new PrismaticJoint(def);
    case JointType.REVOLUTE:
      return new RevoluteJoint(def);
    case JointType.WELD:
      throw new NotImplementedException();
      //return new WeldJoint(def);
    case JointType.FRICTION:
      return new FrictionJoint(def);
    case JointType.LINE:
      throw new NotImplementedException();
      //return new LineJoint(def);
    case JointType.GEAR:
      throw new NotImplementedException();
      //return new GearJoint(def);
    case JointType.PULLEY:
      throw new NotImplementedException();
      //return new PulleyJoint(def);
    case JointType.CONSTANT_VOLUME:
      return new ConstantVolumeJoint(argWorld, def);
  }
  return null;
}
</pre>
</div>
</div>
</div>
<div>
<h3>Static Methods</h3>
<div class="method"><h4 id="destroy">
<button class="show-code">Code</button>
void <strong>destroy</strong>(<a href="../box2d_console/Joint.html">Joint</a> joint) <a class="anchor-link" href="#destroy"
              title="Permalink to Joint.destroy">#</a></h4>
<div class="doc">
<pre class="source">
static void destroy(Joint joint) {
  joint.destructor();
}
</pre>
</div>
</div>
</div>
<div>
<h3>Properties</h3>
<div class="field"><h4 id="active">
<button class="show-code">Code</button>
final bool         <strong>active</strong> <a class="anchor-link"
            href="#active"
            title="Permalink to Joint.active">#</a>
        </h4>
        <div class="doc">
<p>Short-cut function to determine if either body is inactive.</p>
<pre class="source">
bool get active() {
  return bodyA.active &amp;&amp; bodyB.active;
}
</pre>
</div>
</div>
<div class="field"><h4 id="bodyA">
<button class="show-code">Code</button>
<a href="../box2d_console/Body.html">Body</a>         <strong>bodyA</strong> <a class="anchor-link"
            href="#bodyA"
            title="Permalink to Joint.bodyA">#</a>
        </h4>
        <div class="doc">
<pre class="source">
Body bodyA;
</pre>
</div>
</div>
<div class="field"><h4 id="bodyB">
<button class="show-code">Code</button>
<a href="../box2d_console/Body.html">Body</a>         <strong>bodyB</strong> <a class="anchor-link"
            href="#bodyB"
            title="Permalink to Joint.bodyB">#</a>
        </h4>
        <div class="doc">
<pre class="source">
Body bodyB;
</pre>
</div>
</div>
<div class="field"><h4 id="collideConnected">
<button class="show-code">Code</button>
bool         <strong>collideConnected</strong> <a class="anchor-link"
            href="#collideConnected"
            title="Permalink to Joint.collideConnected">#</a>
        </h4>
        <div class="doc">
<pre class="source">
bool collideConnected;
</pre>
</div>
</div>
<div class="field"><h4 id="edgeA">
<button class="show-code">Code</button>
<a href="../box2d_console/JointEdge.html">JointEdge</a>         <strong>edgeA</strong> <a class="anchor-link"
            href="#edgeA"
            title="Permalink to Joint.edgeA">#</a>
        </h4>
        <div class="doc">
<pre class="source">
JointEdge edgeA;
</pre>
</div>
</div>
<div class="field"><h4 id="edgeB">
<button class="show-code">Code</button>
<a href="../box2d_console/JointEdge.html">JointEdge</a>         <strong>edgeB</strong> <a class="anchor-link"
            href="#edgeB"
            title="Permalink to Joint.edgeB">#</a>
        </h4>
        <div class="doc">
<pre class="source">
JointEdge edgeB;
</pre>
</div>
</div>
<div class="field"><h4 id="invIA">
<button class="show-code">Code</button>
num         <strong>invIA</strong> <a class="anchor-link"
            href="#invIA"
            title="Permalink to Joint.invIA">#</a>
        </h4>
        <div class="doc">
<pre class="source">
num invIA;
</pre>
</div>
</div>
<div class="field"><h4 id="invIB">
<button class="show-code">Code</button>
num         <strong>invIB</strong> <a class="anchor-link"
            href="#invIB"
            title="Permalink to Joint.invIB">#</a>
        </h4>
        <div class="doc">
<pre class="source">
num invIB;
</pre>
</div>
</div>
<div class="field"><h4 id="invMassA">
<button class="show-code">Code</button>
num         <strong>invMassA</strong> <a class="anchor-link"
            href="#invMassA"
            title="Permalink to Joint.invMassA">#</a>
        </h4>
        <div class="doc">
<pre class="source">
num invMassA;
</pre>
</div>
</div>
<div class="field"><h4 id="invMassB">
<button class="show-code">Code</button>
num         <strong>invMassB</strong> <a class="anchor-link"
            href="#invMassB"
            title="Permalink to Joint.invMassB">#</a>
        </h4>
        <div class="doc">
<pre class="source">
num invMassB;
</pre>
</div>
</div>
<div class="field"><h4 id="islandFlag">
<button class="show-code">Code</button>
bool         <strong>islandFlag</strong> <a class="anchor-link"
            href="#islandFlag"
            title="Permalink to Joint.islandFlag">#</a>
        </h4>
        <div class="doc">
<pre class="source">
bool islandFlag;
</pre>
</div>
</div>
<div class="field"><h4 id="localCenterA">
<button class="show-code">Code</button>
final <a href="../box2d_console/Vector.html">Vector</a>         <strong>localCenterA</strong> <a class="anchor-link"
            href="#localCenterA"
            title="Permalink to Joint.localCenterA">#</a>
        </h4>
        <div class="doc">
<pre class="source">
final Vector localCenterA;
</pre>
</div>
</div>
<div class="field"><h4 id="localCenterB">
<button class="show-code">Code</button>
final <a href="../box2d_console/Vector.html">Vector</a>         <strong>localCenterB</strong> <a class="anchor-link"
            href="#localCenterB"
            title="Permalink to Joint.localCenterB">#</a>
        </h4>
        <div class="doc">
<pre class="source">
final Vector localCenterB;
</pre>
</div>
</div>
<div class="field inherited"><h4 id="runtimeType">
<button class="show-code">Code</button>
final Type         <strong>runtimeType</strong> <a class="anchor-link"
            href="#runtimeType"
            title="Permalink to Joint.runtimeType">#</a>
        </h4>
        <div class="inherited-from">inherited from Object </div><div class="doc">
<p>A representation of the runtime type of the object.</p>
<pre class="source">
external Type get runtimeType;
</pre>
</div>
</div>
<div class="field"><h4 id="type">
<button class="show-code">Code</button>
int         <strong>type</strong> <a class="anchor-link"
            href="#type"
            title="Permalink to Joint.type">#</a>
        </h4>
        <div class="doc">
<pre class="source">
int type;
</pre>
</div>
</div>
<div class="field"><h4 id="userData">
<button class="show-code">Code</button>
Object         <strong>userData</strong> <a class="anchor-link"
            href="#userData"
            title="Permalink to Joint.userData">#</a>
        </h4>
        <div class="doc">
<pre class="source">
Object userData;
</pre>
</div>
</div>
</div>
<div>
<h3>Operators</h3>
<div class="method inherited"><h4 id="==">
<button class="show-code">Code</button>
bool <strong>operator ==</strong>(other) <a class="anchor-link" href="#=="
              title="Permalink to Joint.operator ==">#</a></h4>
<div class="inherited-from">inherited from Object </div><div class="doc">
<p>The equality operator.</p>
<p>The default behavior for all <code>Object</code>s is to return true if and
only if <code>this</code> and 
<span class="param">other</span> are the same object.</p>
<p>If a subclass overrides the equality operator it should override
the <code>hashCode</code> method as well to maintain consistency.</p>
<pre class="source">
bool operator ==(other) =&gt; identical(this, other);
</pre>
</div>
</div>
</div>
<div>
<h3>Methods</h3>
<div class="method"><h4 id="destructor">
<button class="show-code">Code</button>
void <strong>destructor</strong>() <a class="anchor-link" href="#destructor"
              title="Permalink to Joint.destructor">#</a></h4>
<div class="doc">
<p>Override to handle destruction of joint</p>
<pre class="source">
void destructor() { }
</pre>
</div>
</div>
<div class="method"><h4 id="getAnchorA">
<button class="show-code">Code</button>
void <strong>getAnchorA</strong>(<a href="../box2d_console/Vector.html">Vector</a> argOut) <a class="anchor-link" href="#getAnchorA"
              title="Permalink to Joint.getAnchorA">#</a></h4>
<div class="doc">
<p>Get the anchor point on bodyA in world coordinates.</p>
<pre class="source">
void getAnchorA(Vector argOut) { }
</pre>
</div>
</div>
<div class="method"><h4 id="getAnchorB">
<button class="show-code">Code</button>
void <strong>getAnchorB</strong>(<a href="../box2d_console/Vector.html">Vector</a> argOut) <a class="anchor-link" href="#getAnchorB"
              title="Permalink to Joint.getAnchorB">#</a></h4>
<div class="doc">
<p>Get the anchor point on bodyB in world coordinates.</p>
<pre class="source">
void getAnchorB(Vector argOut) { }
</pre>
</div>
</div>
<div class="method"><h4 id="getReactionForce">
<button class="show-code">Code</button>
void <strong>getReactionForce</strong>(num inv_dt, <a href="../box2d_console/Vector.html">Vector</a> argOut) <a class="anchor-link" href="#getReactionForce"
              title="Permalink to Joint.getReactionForce">#</a></h4>
<div class="doc">
<p>Get the reaction force on body2 at the joint anchor in Newtons.</p>
<pre class="source">
void getReactionForce(num inv_dt, Vector argOut) { }
</pre>
</div>
</div>
<div class="method"><h4 id="getReactionTorque">
<button class="show-code">Code</button>
num <strong>getReactionTorque</strong>(num inv_dt) <a class="anchor-link" href="#getReactionTorque"
              title="Permalink to Joint.getReactionTorque">#</a></h4>
<div class="doc">
<p>Get the reaction torque on body2 in N*m.</p>
<pre class="source">
num getReactionTorque(num inv_dt) { }
</pre>
</div>
</div>
<div class="method inherited"><h4 id="hashCode">
<button class="show-code">Code</button>
int <strong>hashCode</strong>() <a class="anchor-link" href="#hashCode"
              title="Permalink to Joint.hashCode">#</a></h4>
<div class="inherited-from">inherited from Object </div><div class="doc">
<p>Get a hash code for this object.</p>
<p>All objects have hash codes. Hash codes are guaranteed to be the
same for objects that are equal when compared using the equality
operator <code>==</code>. Other than that there are no guarantees about
the hash codes. They will not be consistent between runs and
there are no distribution guarantees.</p>
<p>If a subclass overrides <code>hashCode</code> it should override the
equality operator as well to maintain consistency.</p>
<pre class="source">
external int hashCode();
</pre>
</div>
</div>
<div class="method"><h4 id="initVelocityConstraints">
<button class="show-code">Code</button>
void <strong>initVelocityConstraints</strong>(<a href="../box2d_console/TimeStep.html">TimeStep</a> step) <a class="anchor-link" href="#initVelocityConstraints"
              title="Permalink to Joint.initVelocityConstraints">#</a></h4>
<div class="doc">
<pre class="source">
void initVelocityConstraints(TimeStep step) { }
</pre>
</div>
</div>
<div class="method"><h4 id="Joint">
<button class="show-code">Code</button>
new <strong>Joint</strong>(<a href="../box2d_console/JointDef.html">JointDef</a> def) <a class="anchor-link" href="#Joint"
              title="Permalink to Joint.Joint">#</a></h4>
<div class="doc">
<pre class="source">
Joint(JointDef def) :
  type = def.type,
  _prev = null,
  _next = null,
  bodyA = def.bodyA,
  bodyB = def.bodyB,
  collideConnected = def.collideConnected,
  islandFlag = false,
  userData = def.userData,

  localCenterA = new Vector(),
  localCenterB = new Vector(),
  edgeA = new JointEdge(),
  edgeB = new JointEdge() { }
</pre>
</div>
</div>
<div class="method"><h4 id="Joint.create">
<button class="show-code">Code</button>
factory <strong>Joint.create</strong>(<a href="../box2d_console/World.html">World</a> argWorld, <a href="../box2d_console/JointDef.html">JointDef</a> def) <a class="anchor-link" href="#Joint.create"
              title="Permalink to Joint.Joint.create">#</a></h4>
<div class="doc">
<pre class="source">
factory Joint.create(World argWorld, JointDef def) {
  switch(def.type){
    case JointType.MOUSE:
      throw new NotImplementedException();
      //  return new MouseJoint(def);
    case JointType.DISTANCE:
      return new DistanceJoint(def);
    case JointType.PRISMATIC:
      throw new NotImplementedException();
      //  return new PrismaticJoint(def);
    case JointType.REVOLUTE:
      return new RevoluteJoint(def);
    case JointType.WELD:
      throw new NotImplementedException();
      //return new WeldJoint(def);
    case JointType.FRICTION:
      return new FrictionJoint(def);
    case JointType.LINE:
      throw new NotImplementedException();
      //return new LineJoint(def);
    case JointType.GEAR:
      throw new NotImplementedException();
      //return new GearJoint(def);
    case JointType.PULLEY:
      throw new NotImplementedException();
      //return new PulleyJoint(def);
    case JointType.CONSTANT_VOLUME:
      return new ConstantVolumeJoint(argWorld, def);
  }
  return null;
}
</pre>
</div>
</div>
<div class="method inherited"><h4 id="noSuchMethod">
<button class="show-code">Code</button>
<strong>noSuchMethod</strong>(String name, List args) <a class="anchor-link" href="#noSuchMethod"
              title="Permalink to Joint.noSuchMethod">#</a></h4>
<div class="inherited-from">inherited from Object </div><div class="doc">
<p><code>noSuchMethod</code> is invoked when users invoke a non-existant method
on an object. The name of the method and the arguments of the
invocation are passed to <code>noSuchMethod</code>. If <code>noSuchMethod</code>
returns a value, that value becomes the result of the original
invocation.</p>
<p>The default behavior of <code>noSuchMethod</code> is to throw a
<code>noSuchMethodError</code>.</p>
<pre class="source">
external Dynamic noSuchMethod(String name, List args);
</pre>
</div>
</div>
<div class="method inherited"><h4 id="Object">
<button class="show-code">Code</button>
const <strong>Object</strong>() <a class="anchor-link" href="#Object"
              title="Permalink to Joint.Object">#</a></h4>
<div class="inherited-from">inherited from Object </div><div class="doc">
<p>Creates a new <code>Object</code> instance.</p>
<p><code>Object</code> instances have no meaningful state, and are only useful
through their identity. An <code>Object</code> instance is equal to itself
only.</p>
<pre class="source">
const Object();
</pre>
</div>
</div>
<div class="method"><h4 id="solvePositionConstraints">
<button class="show-code">Code</button>
bool <strong>solvePositionConstraints</strong>(num baumgarte) <a class="anchor-link" href="#solvePositionConstraints"
              title="Permalink to Joint.solvePositionConstraints">#</a></h4>
<div class="doc">
<p>This returns true if the position errors are within tolerance.</p>
<pre class="source">
bool solvePositionConstraints(num baumgarte) { }
</pre>
</div>
</div>
<div class="method"><h4 id="solveVelocityConstraints">
<button class="show-code">Code</button>
void <strong>solveVelocityConstraints</strong>(<a href="../box2d_console/TimeStep.html">TimeStep</a> step) <a class="anchor-link" href="#solveVelocityConstraints"
              title="Permalink to Joint.solveVelocityConstraints">#</a></h4>
<div class="doc">
<pre class="source">
void solveVelocityConstraints(TimeStep step) { }
</pre>
</div>
</div>
<div class="method inherited"><h4 id="toString">
<button class="show-code">Code</button>
String <strong>toString</strong>() <a class="anchor-link" href="#toString"
              title="Permalink to Joint.toString">#</a></h4>
<div class="inherited-from">inherited from Object </div><div class="doc">
<p>Returns a string representation of this object.</p>
<pre class="source">
external String toString();
</pre>
</div>
</div>
</div>
        </div>
        <div class="clear"></div>
        </div>
        
        <div class="footer">
          
        </div>
        <script async src="../client-live-nav.js"></script>
        </body></html>
        
